Skip to main content

Users List

AutomatR.Slack.Activities.UsersList

The "Users List" activity in AutomatR is part of the Slack activities package, allowing automation processes to retrieve a list of users in a Slack admin user's account. This activity provides information about each user, such as their ID, real name, username, and role.

Properties

NameDescription
Misc
Display NameProvides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name.
Optional
DelaySpecifies the amount of time (in seconds) to wait before executing the "Users List" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1.
Output
ResultOutputs the response as a list of user details in the form of List<UsersListResponse>. This includes information such as user ID, real name, username, and role. Variables of relevant types (e.g., List<UsersListResponse> variables) to store the user list.

How to use:

  1. Drag and drop the "Users List" activity onto the workflow.
  2. Configure the properties, such as the optional delay.
  3. Execute the workflow to retrieve the list of users from the Slack admin user's account.

Example: Consider an example where the "Users List" activity is used to retrieve the list of users:

Users List:
Delay: 2
Result: userList

In this example, the activity retrieves the list of users with a 2-second delay. The list of users is stored in the userList variable for further processing in the workflow.